<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <meta name="author" content="PG-Strom Development Team">
  <link rel="shortcut icon" href="../img/favicon.ico">
  <title>SQLオブジェクト - PG-Strom Manual</title>
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
  <link href="//fonts.googleapis.com/earlyaccess/notosansjp.css" rel="stylesheet">
  <link href="//fonts.googleapis.com/css?family=Open+Sans:600,800" rel="stylesheet">
  <link href="../custom.css" rel="stylesheet">
  
  <script>
    // Current page data
    var mkdocs_page_name = "SQL\u30aa\u30d6\u30b8\u30a7\u30af\u30c8";
    var mkdocs_page_input_path = "ref_sqlfuncs.md";
    var mkdocs_page_url = null;
  </script>
  
  <script src="../js/jquery-2.1.1.min.js" defer></script>
  <script src="../js/modernizr-2.8.3.min.js" defer></script>
  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
  <script>hljs.initHighlightingOnLoad();</script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href=".." class="icon icon-home"> PG-Strom Manual</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
  [<strong>Japanese</strong> | <a href="../../ref_sqlfuncs/"    style="color: #cccccc">English</a>]
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	<ul class="current">
	  
          
            <li class="toctree-l1">
		
    <a class="" href="..">はじめに</a>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="../install/">インストール</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">利用ガイド</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../operations/">基本的な操作</a>
                </li>
                <li class="">
                    
    <a class="" href="../sys_admin/">システム管理</a>
                </li>
                <li class="">
                    
    <a class="" href="../brin/">BRINインデックス</a>
                </li>
                <li class="">
                    
    <a class="" href="../partition/">パーティション</a>
                </li>
                <li class="">
                    
    <a class="" href="../postgis/">PostGIS対応</a>
                </li>
                <li class="">
                    
    <a class="" href="../troubles/">トラブルシューティング</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">先進機能</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../ssd2gpu/">GPUダイレクトSQL</a>
                </li>
                <li class="">
                    
    <a class="" href="../arrow_fdw/">Apache Arrow</a>
                </li>
                <li class="">
                    
    <a class="" href="../gstore_fdw/">GPUメモリストア</a>
                </li>
                <li class="">
                    
    <a class="" href="../python/">Python連携</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">リファレンス</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../ref_types/">データ型</a>
                </li>
                <li class="">
                    
    <a class="" href="../ref_devfuncs/">関数と演算子</a>
                </li>
                <li class=" current">
                    
    <a class="current" href="./">SQLオブジェクト</a>
    <ul class="subnav">
            
    <li class="toctree-l3"><a href="#_1">デバイス情報関数</a></li>
    

    <li class="toctree-l3"><a href="#arrow_fdw">Arrow_Fdw関連</a></li>
    

    <li class="toctree-l3"><a href="#gpu">GPUデータフレーム関数</a></li>
    

    <li class="toctree-l3"><a href="#_2">テストデータ生成関数</a></li>
    

    <li class="toctree-l3"><a href="#_3">その他の関数</a></li>
    

    <li class="toctree-l3"><a href="#_4">システムビュー</a></li>
    

    </ul>
                </li>
                <li class="">
                    
    <a class="" href="../ref_params/">GUCパラメータ</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="../release_note/">リリースノート</a>
	    </li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="..">PG-Strom Manual</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="..">Docs</a> &raquo;</li>
    
      
        
          <li>リファレンス &raquo;</li>
        
      
    
    <li>SQLオブジェクト</li>
    <li class="wy-breadcrumbs-aside">
      
    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <h1>SQLオブジェクト</h1>

<p>本章ではPG-Stromが独自に提供するSQLオブジェクトについて説明します。</p>
<h1 id="_1">デバイス情報関数</h1>
<table>
<thead>
<tr>
<th align="left">関数</th>
<th align="center">戻り値</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>gpu_device_name(int = 0)</code></td>
<td align="center"><code>text</code></td>
<td align="left">指定したGPUデバイスの名前を返します</td>
</tr>
<tr>
<td align="left"><code>gpu_global_memsize(int = 0)</code></td>
<td align="center"><code>bigint</code></td>
<td align="left">指定したGPUデバイスのデバイスメモリ容量を返します</td>
</tr>
<tr>
<td align="left"><code>gpu_max_blocksize(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスにおけるブロックサイズの最大値を返します。現在サポート対象のGPUでは1024です。</td>
</tr>
<tr>
<td align="left"><code>gpu_warp_size(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスにおけるワープサイズを返します。現在サポート対象のGPUでは32です。</td>
</tr>
<tr>
<td align="left"><code>gpu_max_shared_memory_perblock(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスにおけるブロックあたり共有メモリの最大値を返します。</td>
</tr>
<tr>
<td align="left"><code>gpu_num_registers_perblock(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスにおけるブロックあたりレジスタ数を返します。</td>
</tr>
<tr>
<td align="left"><code>gpu_num_multiptocessors(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスにおけるSM(Streaming Multiprocessor)ユニットの数を返します。</td>
</tr>
<tr>
<td align="left"><code>gpu_num_cuda_cores(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスにおけるCUDAコア数を返します。</td>
</tr>
<tr>
<td align="left"><code>gpu_cc_major(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスのCC(Compute Capability)メジャーバージョンを返します。</td>
</tr>
<tr>
<td align="left"><code>gpu_cc_minor(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスのCC(Compute Capability)マイナーバージョンを返します。</td>
</tr>
<tr>
<td align="left"><code>gpu_pci_id(int = 0)</code></td>
<td align="center"><code>int</code></td>
<td align="left">指定したGPUデバイスが接続されているPCIバスIDを返します。</td>
</tr>
</tbody>
</table>
<h1 id="arrow_fdw">Arrow_Fdw関連</h1>
<table>
<thead>
<tr>
<th align="left">関数</th>
<th align="center">戻り値</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>pgstrom.arrow_fdw_truncate(regclass)</code></td>
<td align="center"><code>bool</code></td>
<td align="left">指定されたArrow_Fdw外部テーブルの内容を全て消去します。Arrow_Fdw外部テーブルは<code>writable</code>である必要があります。</td>
</tr>
</tbody>
</table>
<h1 id="gpu">GPUデータフレーム関数</h1>
<table>
<thead>
<tr>
<th align="left">関数</th>
<th align="center">戻り値</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>pgstrom.arrow_fdw_export_cupy(regclass, text[], int)</code></td>
<td align="center"><code>text</code></td>
<td align="left">指定された列のArrow_Fdw外部テーブルの内容をcuPyのデータフレーム(<code>cupy.ndarray</code>)としてエクスポートします。GPUバッファはセッション終了時に自動的に解放されます。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.arrow_fdw_export_cupy_pinned(regclass, text[], int)</code></td>
<td align="center"><code>text</code></td>
<td align="left">指定された列のArrow_Fdw外部テーブルの内容をcuPyのデータフレーム(<code>cupy.ndarray</code>)としてエクスポートします。GPUバッファはピンニングされ、セッション終了後も有効です。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.arrow_fdw_put_gpu_buffer(text)</code></td>
<td align="center"><code>bool</code></td>
<td align="left">上記の関数でエクスポートされたGPUバッファを解放します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.arrow_fdw_unpin_gpu_buffer(text)</code></td>
<td align="center"><code>bool</code></td>
<td align="left">上記の関数でエクスポートされたGPUバッファのピンニングを解除します。</td>
</tr>
</tbody>
</table>
<h1 id="_2">テストデータ生成関数</h1>
<table>
<thead>
<tr>
<th align="left">関数</th>
<th align="center">戻り値</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>pgstrom.random_setseed(int)</code></td>
<td align="center"><code>void</code></td>
<td align="left">乱数の系列を初期化します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_int(float=0.0, bigint=0, bigint=INT_MAX)</code></td>
<td align="center"><code>bigint</code></td>
<td align="left"><code>bigint</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_float(float=0.0, float=0.0, float=1.0)</code></td>
<td align="center"><code>float</code></td>
<td align="left"><code>float</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_date(float=0.0, date='2015-01-01', date='2025-12-31')</code></td>
<td align="center"><code>date</code></td>
<td align="left"><code>date</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_time(float=0.0, time='00:00:00', time='23:59:59')</code></td>
<td align="center"><code>time</code></td>
<td align="left"><code>time</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_timetz(float=0.0, time='00:00:00', time='23:59:59')</code></td>
<td align="center"><code>timetz</code></td>
<td align="left"><code>timetz</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_timestamp(float=0.0, timestamp='2015-01-01', timestamp='2025-01-01')</code></td>
<td align="center"><code>timestamp</code></td>
<td align="left"><code>timestamp</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_macaddr(float=0.0, macaddr='ab:cd:00:00:00', macaddr='ab:cd:ff:ff:ff:ff')</code></td>
<td align="center"><code>macaddr</code></td>
<td align="left"><code>macaddr</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_inet(float=0.0, inet='192.168.0.1/16')</code></td>
<td align="center"><code>inet</code></td>
<td align="left"><code>inet</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_text(float=0.0, text='test_**')</code></td>
<td align="center"><code>text</code></td>
<td align="left"><code>text</code>型のランダムデータを生成します。第二引数の'*'文字をランダムに置き換えます。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_text_len(float=0.0, int=10)</code></td>
<td align="center"><code>text</code></td>
<td align="left"><code>text</code>型のランダムデータを指定文字列長の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_int4range(float=0.0, bigint=0, bigint=INT_MAX)</code></td>
<td align="center"><code>int4range</code></td>
<td align="left"><code>int4range</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_int8range(float=0.0, bigint=0, bigint=LONG_MAX)</code></td>
<td align="center"><code>int8range</code></td>
<td align="left"><code>int8range</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_tsrange(float=0.0, timestamp='2015-01-01', timestamp='2025-01-01')</code></td>
<td align="center"><code>tsrange</code></td>
<td align="left"><code>tsrange</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_tstzrange(float=0.0, timestamptz='2015-01-01', timestamptz='2025-01-01')</code></td>
<td align="center"><code>tstzrange</code></td>
<td align="left"><code>tstzrange</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
<tr>
<td align="left"><code>pgstrom.random_daterange(float=0.0, date='2015-01-01', date='2025-12-31')</code></td>
<td align="center"><code>daterange</code></td>
<td align="left"><code>daterange</code>型のランダムデータを指定の範囲内で生成します。</td>
</tr>
</tbody>
</table>
<h1 id="_3">その他の関数</h1>
<table>
<thead>
<tr>
<th align="left">関数</th>
<th align="center">戻り値</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>pgstrom.license_query()</code></td>
<td align="center"><code>text</code></td>
<td align="left">現在ロードされている商用サブスクリプションを表示します。</td>
</tr>
</tbody>
</table>
<h1 id="_4">システムビュー</h1>
<p>PG-Stromは内部状態をユーザやアプリケーションに出力するためのシステムビューをいくつか提供しています。
これらのシステムビューは将来のバージョンで情報が追加される可能性があります。そのため、アプリケーションから<code>SELECT * FROM ...</code>によってこれらシステムビューを参照する事は避けてください。</p>
<p><strong>pgstrom.device_info</strong></p>
<p><code>pgstrom.device_info</code>システムビューは、PG-Stromが認識しているGPUのデバイス属性値を出力します。
GPUはモデルごとにコア数やメモリ容量、最大スレッド数などのスペックが異なっており、PL/CUDA関数などで直接GPUのプログラミングを行う場合には、これらの情報を元にソフトウェアを最適化する必要があります。</p>
<table>
<thead>
<tr>
<th align="left">名前</th>
<th align="left">データ型</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">device_nr</td>
<td align="left"><code>int</code></td>
<td align="left">GPUデバイス番号</td>
</tr>
<tr>
<td align="left">aindex</td>
<td align="left"><code>int</code></td>
<td align="left">属性インデックス</td>
</tr>
<tr>
<td align="left">attribute</td>
<td align="left"><code>text</code></td>
<td align="left">デバイス属性名</td>
</tr>
<tr>
<td align="left">value</td>
<td align="left"><code>text</code></td>
<td align="left">デバイス属性値</td>
</tr>
</tbody>
</table>
<p><strong>pgstrom.device_preserved_meminfo</strong></p>
<p><code>pgstrom.device_preserved_meminfo</code>システムビューは、複数のPostgreSQLバックエンドプロセスから共有するために予め確保済みのGPUデバイスメモリ領域の情報を出力します。
現在のところ、Arrow_FdwのPython連携機能がこれを使用しています。</p>
<table>
<thead>
<tr>
<th align="left">名前</th>
<th align="left">データ型</th>
<th align="left">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">device_nr</td>
<td align="left"><code>int</code></td>
<td align="left">GPUデバイス番号</td>
</tr>
<tr>
<td align="left">handle</td>
<td align="left"><code>bytea</code></td>
<td align="left">確保済みGPUデバイスメモリのIPCハンドラ</td>
</tr>
<tr>
<td align="left">owner</td>
<td align="left"><code>regrole</code></td>
<td align="left">確保済みGPUデバイスメモリの作成者</td>
</tr>
<tr>
<td align="left">length</td>
<td align="left"><code>bigint</code></td>
<td align="left">確保済みGPUデバイスメモリのバイト単位の長さ</td>
</tr>
<tr>
<td align="left">ctime</td>
<td align="left"><code>timestamp with time zone</code></td>
<td align="left">確保済みGPUデバイスメモリの作成時刻</td>
</tr>
</tbody>
</table>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../ref_params/" class="btn btn-neutral float-right" title="GUCパラメータ">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
        <a href="../ref_devfuncs/" class="btn btn-neutral" title="関数と演算子"><span class="icon icon-circle-arrow-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
      
        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
      
        <span><a href="../ref_devfuncs/" style="color: #fcfcfc;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../ref_params/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script>var base_url = '..';</script>
    <script src="../js/theme.js" defer></script>
      <script src="../search/main.js" defer></script>

</body>
</html>
